POST api/v1/dataservice/find/{tableName}?fieldList[0]={fieldList[0]}&fieldList[1]={fieldList[1]}

Finds data in specified table with given search parameters.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tableName

Name of the table to search.

string

Required

fieldList

The list of fields to return. (optional). If empty, all fields will be returned

Collection of string

Required

Body Parameters

The search parameters.

Query
NameDescriptionTypeAdditional information
Operator

LogicalOperator

Required

PagingData

PagingData

Required

SearchFields

Collection of QueryField

Required

ReturnDataFormat

Collection of DataFieldFormat

None.

Request Formats

application/json, text/json

Sample:
{
  "Operator": "And",
  "PagingData": {
    "PageSize": 1,
    "PageIndex": 2,
    "TotalRecords": 3,
    "TotalPages": 4,
    "Token": "sample string 5"
  },
  "SearchFields": [
    {
      "FieldName": "sample string 1",
      "Value": "sample string 2",
      "ComparisonOperator": "Equal"
    },
    {
      "FieldName": "sample string 1",
      "Value": "sample string 2",
      "ComparisonOperator": "Equal"
    }
  ],
  "ReturnDataFormat": [
    {
      "Name": "sample string 1",
      "Format": "sample string 2",
      "AnonymizationOption": "Default"
    },
    {
      "Name": "sample string 1",
      "Format": "sample string 2",
      "AnonymizationOption": "Default"
    }
  ]
}

application/xml, text/xml

Sample:
<Query xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Paperclip.IOTA.WebApi.Model">
  <Operator>And</Operator>
  <PagingData>
    <PageIndex>2</PageIndex>
    <PageSize>1</PageSize>
    <Token>sample string 5</Token>
    <TotalPages>4</TotalPages>
    <TotalRecords>3</TotalRecords>
  </PagingData>
  <ReturnDataFormat>
    <DataFieldFormat>
      <AnonymizationOption>Default</AnonymizationOption>
      <Format>sample string 2</Format>
      <Name>sample string 1</Name>
    </DataFieldFormat>
    <DataFieldFormat>
      <AnonymizationOption>Default</AnonymizationOption>
      <Format>sample string 2</Format>
      <Name>sample string 1</Name>
    </DataFieldFormat>
  </ReturnDataFormat>
  <SearchFields>
    <QueryField>
      <ComparisonOperator>Equal</ComparisonOperator>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
    </QueryField>
    <QueryField>
      <ComparisonOperator>Equal</ComparisonOperator>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
    </QueryField>
  </SearchFields>
</Query>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Query'.

Response Information

Resource Description

PcSafeData
NameDescriptionTypeAdditional information
TransactionId

string

None.

PagingData

PagingData

None.

DataEntities

Collection of DataEntity

None.

Response Formats

application/json, text/json

Sample:
{
  "TransactionId": "sample string 1",
  "PagingData": {
    "PageSize": 1,
    "PageIndex": 2,
    "TotalRecords": 3,
    "TotalPages": 4,
    "Token": "sample string 5"
  },
  "DataEntities": [
    {
      "RefId": "sample string 1",
      "RowId": "sample string 2",
      "Fields": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "RefId": "sample string 1",
      "RowId": "sample string 2",
      "Fields": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<PcSafeData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Paperclip.IOTA.WebApi.Model">
  <DataEntities>
    <DataEntity>
      <Fields>
        <DataField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </DataField>
        <DataField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </DataField>
      </Fields>
      <RefId>sample string 1</RefId>
      <RowId>sample string 2</RowId>
    </DataEntity>
    <DataEntity>
      <Fields>
        <DataField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </DataField>
        <DataField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </DataField>
      </Fields>
      <RefId>sample string 1</RefId>
      <RowId>sample string 2</RowId>
    </DataEntity>
  </DataEntities>
  <PagingData>
    <PageIndex>2</PageIndex>
    <PageSize>1</PageSize>
    <Token>sample string 5</Token>
    <TotalPages>4</TotalPages>
    <TotalRecords>3</TotalRecords>
  </PagingData>
  <TransactionId>sample string 1</TransactionId>
</PcSafeData>